<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JS-ITM API - JSITM.TM</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
	<h1>
		<a href="http://code.google.com/p/js-itm/">JS-ITM</a>
	</h1>
	<h2>
		A javascript library to convert between Israel Transverse Mercator and GPS (wgs84) 
	</h2>
</div>

		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center">
	<a href="../index.html">Class Index</a>
	| 
	<a href="../files.html">File Index</a>
</div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
		<li>
			<a href="../symbols/JSITM.html">JSITM</a>
		</li>
	
		<li>
			<a href="../symbols/JSITM.Ellipsoid.html">JSITM.Ellipsoid</a>
		</li>
	
		<li>
			<a href="../symbols/JSITM.LatLng.html">JSITM.LatLng</a>
		</li>
	
		<li>
			<a href="../symbols/JSITM.Point.html">JSITM.Point</a>
		</li>
	
		<li>
			<a href="../symbols/JSITM.TM.html">JSITM.TM</a>
		</li>
	
		<li>
			<a href="../symbols/JSITM.Translation.html">JSITM.Translation</a>
		</li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class JSITM.TM
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/js-itm.js.html">js-itm.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class JSITM.TM.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/JSITM.TM.html#constructor">JSITM.TM</a></b>(reference, e0, n0, f0, lat0, lng0)
							</div>
							<div class="description">Cretaes a new TM (Transverse Mercator Projection).</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class JSITM.TM.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;private&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/JSITM.TM.html#InitialLat">InitialLat</a></b>(y)
								</div>
								<div class="description">Returns the  initial value for Latitude in radians.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/JSITM.TM.html#Marc">Marc</a></b>(radlat)
								</div>
								<div class="description">Compute meridional arc</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/JSITM.TM.html#project">project</a></b>(latitude)
								</div>
								<div class="description">Project Latitude and longitude to Transverse Mercator coordinates</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/JSITM.TM.html#unproject">unproject</a></b>(point)
								</div>
								<div class="description">Un-project Transverse Mercator eastings and northings back to latitude and longtitude.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>JSITM.TM</b>(reference, e0, n0, f0, lat0, lng0)
				</div>
				
				<div class="description">
					Cretaes a new TM (Transverse Mercator Projection).<br>
For more info see <a href="http://en.wikipedia.org/wiki/Transverse_Mercator">http://en.wikipedia.org/wiki/Transverse_Mercator</a>
					
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{<a href="../symbols/JSITM.Ellipsoid.html#constructor">JSITM.Ellipsoid</a>}</span>  <b>reference</b>
								
							</dt>
								<dd>ellipsoid</dd>
						
							<dt>
								<span class="light fixedFont">{Number}</span>  <b>e0</b>
								
							</dt>
								<dd>eastings of false origin in meters</dd>
						
							<dt>
								<span class="light fixedFont">{Number}</span>  <b>n0</b>
								
							</dt>
								<dd>northings of false origin in meters</dd>
						
							<dt>
								<span class="light fixedFont">{Number}</span>  <b>f0</b>
								
							</dt>
								<dd>central meridian scale factor</dd>
						
							<dt>
								<span class="light fixedFont">{Number}</span>  <b>lat0</b>
								
							</dt>
								<dd>latitude of false origin in decimal degrees.</dd>
						
							<dt>
								<span class="light fixedFont">{Number}</span>  <b>lng0</b>
								
							</dt>
								<dd>longitude of false origin in decimal degrees.</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="InitialLat"> </a>
					<div class="fixedFont">&lt;private&gt; 
					
					<span class="light">{Number}</span>
					<b>InitialLat</b>(y)
					
					</div>
					<div class="description">
						Returns the  initial value for Latitude in radians.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>y</b>
									
								</dt>
								<dd>northings of point</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="Marc"> </a>
					<div class="fixedFont">&lt;private&gt; 
					
					<span class="light">{Number}</span>
					<b>Marc</b>(radlat)
					
					</div>
					<div class="description">
						Compute meridional arc
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>radlat</b>
									
								</dt>
								<dd>latitude of meridian in radians</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Number}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="project"> </a>
					<div class="fixedFont">
					
					<span class="light">{<a href="../symbols/JSITM.Point.html#constructor">JSITM.Point</a>}</span>
					<b>project</b>(latitude)
					
					</div>
					<div class="description">
						Project Latitude and longitude to Transverse Mercator coordinates
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/JSITM.LatLng.html#constructor">JSITM.LatLng</a>}</span> <b>latitude</b>
									
								</dt>
								<dd>and longtitude  to convert</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/JSITM.Point.html#constructor">JSITM.Point</a>}</span> projected coordinates</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="unproject"> </a>
					<div class="fixedFont">
					
					<span class="light">{<a href="../symbols/JSITM.LatLng.html#constructor">JSITM.LatLng</a>}</span>
					<b>unproject</b>(point)
					
					</div>
					<div class="description">
						Un-project Transverse Mercator eastings and northings back to latitude and longtitude.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/JSITM.Point.html#constructor">JSITM.Point</a>}</span> <b>point</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/JSITM.LatLng.html#constructor">JSITM.LatLng</a>}</span> latitude and longtitude on the refernced ellipsoid's surface</dd>
							
							</dl>
						
						
						

					
				
			
			
			<hr />
		</div>
		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.2 on Sun Apr 18 2010 23:24:01 GMT+0300 (IDT)
		</div>
	</body>
</html>
